<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class prefix_v6</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="ODTONE 0.4">
<link rel="up" href="../../../odtone_net_library.html#header..home.carlos.Projectos.odtone.inc.odtone.net.ip.prefix_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/net/ip/prefix.hpp&gt;">
<link rel="prev" href="option.html" title="Class option">
<link rel="next" href="../link/address_mac.html" title="Class address_mac">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="'ODTONE - Open Dot Twenty One'" width="100" height="100" src="../../.././images/logo.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="option.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../odtone_net_library.html#header..home.carlos.Projectos.odtone.inc.odtone.net.ip.prefix_hpp"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../link/address_mac.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="odtone.net.ip.prefix_v6"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class prefix_v6</span></h2>
<p>odtone::net::ip::prefix_v6</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../odtone_net_library.html#header..home.carlos.Projectos.odtone.inc.odtone.net.ip.prefix_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/net/ip/prefix.hpp&gt;">/home/carlos/Projectos/odtone/inc/odtone/net/ip/prefix.hpp</a>&gt;

</span>
<span class="keyword">class</span> <a class="link" href="prefix_v6.html" title="Class prefix_v6">prefix_v6</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">address_v6</span><span class="special">::</span><span class="identifier">bytes_type</span> <a name="odtone.net.ip.prefix_v6.bytes_type"></a><span class="identifier">bytes_type</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="prefix_v6.html#odtone.net.ip.prefix_v6construct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="prefix_v6.html#idp5064840-bb"><span class="identifier">prefix_v6</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="prefix_v6.html#idp5065136-bb"><span class="identifier">prefix_v6</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">bytes_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">uint</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="prefix_v6.html#idp5066656-bb"><span class="identifier">prefix_v6</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">address_v6</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">uint</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="prefix_v6.html#idp5057968-bb">public static functions</a></span>
  <span class="keyword">static</span> <a class="link" href="prefix_v6.html" title="Class prefix_v6">prefix_v6</a> <a class="link" href="prefix_v6.html#idp5058152-bb"><span class="identifier">from_string</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="prefix_v6.html#idp5059912-bb">public member functions</a></span>
  <span class="keyword">const</span> <span class="identifier">bytes_type</span> <span class="special">&amp;</span> <a class="link" href="prefix_v6.html#idp5060096-bb"><span class="identifier">bytes</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">uint</span> <a class="link" href="prefix_v6.html#idp5061152-bb"><span class="identifier">length</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <a class="link" href="prefix_v6.html#idp5062160-bb"><span class="keyword">operator</span> <span class="identifier">undefined_bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="prefix_v6.html#idp5062656-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="prefix_v6.html#idp5063136-bb"><span class="identifier">match</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">address_v6</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="prefix_v6.html#idp5068200-bb">friend functions</a></span>
  <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> <a class="link" href="prefix_v6.html#idp5068408-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="prefix_v6.html" title="Class prefix_v6">prefix_v6</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp21062056"></a><h2>Description</h2>
<p>This class represents the base IPv6 Prefix. </p>
<div class="refsect2">
<a name="idp21062448"></a><h3>
<a name="odtone.net.ip.prefix_v6construct-copy-destruct"></a><code class="computeroutput">prefix_v6</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp5064840-bb"></a><span class="identifier">prefix_v6</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Construct an empty IPv6 Prefix. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp5065136-bb"></a><span class="identifier">prefix_v6</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">bytes_type</span> <span class="special">&amp;</span> addr<span class="special">,</span> <span class="identifier">uint</span> length<span class="special">)</span><span class="special">;</span></pre>
<p>Construct an IPv6 Prefix.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">addr</code></span></p></td>
<td><p>The IPv6 Prefix raw bytes. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">length</code></span></p></td>
<td><p>The IPv6 Prefix byte length. </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp5066656-bb"></a><span class="identifier">prefix_v6</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">address_v6</span> <span class="special">&amp;</span> addr<span class="special">,</span> <span class="identifier">uint</span> length<span class="special">)</span><span class="special">;</span></pre>
<p>Construct an IPv6 Prefix.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">addr</code></span></p></td>
<td><p>The IPv6 Prefix. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">length</code></span></p></td>
<td><p>The IPv6 Prefix byte length. </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp21077536"></a><h3>
<a name="idp5057968-bb"></a><code class="computeroutput">prefix_v6</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <a class="link" href="prefix_v6.html" title="Class prefix_v6">prefix_v6</a> <a name="idp5058152-bb"></a><span class="identifier">from_string</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> str<span class="special">)</span><span class="special">;</span></pre>
<p>Get the IPv6 Prefix from a string.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
<td><p>The input string. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The extracted IPv6 Prefix. </p></td>
</tr>
</tbody>
</table></div>
</li></ol></div>
</div>
<div class="refsect2">
<a name="idp21085088"></a><h3>
<a name="idp5059912-bb"></a><code class="computeroutput">prefix_v6</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">bytes_type</span> <span class="special">&amp;</span> <a name="idp5060096-bb"></a><span class="identifier">bytes</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the IPv6 Prefix raw bytes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The IPv6 Prefix raw bytes. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint</span> <a name="idp5061152-bb"></a><span class="identifier">length</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the IPv6 Prefix length.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The IPv6 Prefix length. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem"><pre class="literallayout"><a name="idp5062160-bb"></a><span class="keyword">operator</span> <span class="identifier">undefined_bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp5062656-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp5063136-bb"></a><span class="identifier">match</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">address_v6</span> <span class="special">&amp;</span> addr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Check if the IPv6 Prefix is equal to another IPv6 Prefix.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">addr</code></span></p></td>
<td><p>The IPv6 Prefix to compare with. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>True if they are equal or false otherwise. </p></td>
</tr>
</tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp21105248"></a><h3>
<a name="idp5068200-bb"></a><code class="computeroutput">prefix_v6</code> friend functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> <a name="idp5068408-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> out<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="prefix_v6.html" title="Class prefix_v6">prefix_v6</a> <span class="special">&amp;</span> lhr<span class="special">)</span><span class="special">;</span></pre>
<p>IPv6 Prefix output.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">lhr</code></span></p></td>
<td><p>The IPv6 Prefix. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">out</code></span></p></td>
<td><p>ostream. </p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>ostream reference. </p></td>
</tr>
</tbody>
</table></div>
</li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Universidade
      Aveiro<br>Copyright &#169; 2009-2012 Instituto
      de Telecomunica&#231;&#245;es - P&#243;lo Aveiro<p>
        This software is distributed under a license. The full license agreement
        can be found in the LICENSE in this distribution. This software may not be
        copied, modified, sold or distributed other than expressed in the named license
        agreement. This software is distributed without any warranty.
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="option.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../odtone_net_library.html#header..home.carlos.Projectos.odtone.inc.odtone.net.ip.prefix_hpp"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../link/address_mac.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
